<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
    <head>
        <title>splat: Scalable Periodic LDAP Attribute Transmogrifier</title>
        <meta http-equiv="content-type" content="text/html;
        charset=iso-8859-1"/>
        <link rel="stylesheet" type="text/css" href="default.css"/>
    </head>
    <body>
        <h1>Splat: Scalable Periodic LDAP Attribute Transmogrifier<img
            style="float: right;" src="dpw.png" alt="DPW Logo"/></h1>

        <ul id="nav">
            <li><a href="#intro">Introduction</a></li>
            <li><a href="#get">Download</a></li>
            <li><a href="#require">Requirements</a></li>
            <li><a href="#install">Installation</a></li>
            <li><a href="#support">Support</a></li>
            <li><a href="#cav">Caveats</a></li>
        </ul>

        <h2><a id="intro">Introduction</a></h2>
        <p>
            Splat is a daemon designed to help keep information in an LDAP
            directory in sync with information outside of an LDAP directory.
            This information can be any set of attributes on any object in the
            LDAP directory.
        </p>

        <p>
            Splat currently supports the following:
        </p>

        <ul>
            <li>Writing SSH public keys</li>
            <li>Writing .forward files</li>
            <li>Creating user home directories</li>
            <li>Archiving and deleting home directories of deleted users</li>
        </ul>

        <p>
            You may send patches, bug reports, and complaints to <a
            href="https://dpw.threerings.net/mailman/listinfo/splat">the Splat
            mailing list</a>.
        </p>

        <h2><a id="get">Download</a></h2>
        <p>
            The latest release of Splat is 1.1.1, which can be downloaded
            <a href="splatd-1.1.1.tar.gz">here</a> (<a 
            href="splatd-1.1.1.tar.gz.sig">gpg signature</a>).
        </p>
        <p>
            The public key needed to verify this signature (key ID 0x85971303) 
            can be obtained 
            <a href="http://dpw.threerings.net/dpw_public_key.asc">here</a>, or
            retrieved from one of the subkeys.pgp.net keyservers. 
        </p>
        <h2><a id="require">Requirements</a></h2>
        <ul>
            <li><a href="http://www.python.org">Python 2.4</a></li>
            <li><a href="http://twistedmatrix.com">Twisted Networking Framework</a></li>
            <li><a href="http://python-ldap.sourceforge.net/">Python LDAP</a></li>
            <li><a href="http://www.zope.org/Members/fdrake/zconfig/">ZConfig</a></li>
        </ul>
        
        <h2><a id="install">Installation</a></h2>
        
        <p>
            Splat uses the standard Python distutils. To install, run setup.py:
        </p>
        <pre>./setup.py install</pre>

        <p>
            The splat framework will be installed in the Python site-packages
            directory.  The <em>splatd</em> daemon will be installed in the
            Python-specified bin directory. An example configuration file,
            <em>splat.conf</em>, is supplied with the source distribution.
        </p>

        <p>
            There are also splat packages available for several operating
            systems. Splat is in the FreeBSD ports collection as net/splatd, and
            in MacPorts as splat. There is an Ubuntu 6.06 package for Splat 
			1.0 that can be installed from our apt repositories by adding the 
			lines below to /etc/apt/sources.list:
        </p>

<pre>deb http://dpw.threerings.net/ubuntu dapper universe
deb-src http://dpw.threerings.net/ubuntu dapper universe</pre>

        <p>
			The package name is splatd. A more recent version has been uploaded 
			to Ubuntu's Universe component and should be available from there  
			after the next Ubuntu release, Feisty Fawn. There is no current 
			Debian package, but it should be trivial to port the Ubuntu 
			package. An RFP bug report for a Debian Splat package can be found 
			<a href=
			"http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=374926">here</a>.
		</p>

        <h2><a id="support">Support</a></h2>
        <p>
            A <a href="manual/">Splat Manual</a> is available.  You may also
            join the <a
            href="https://dpw.threerings.net/mailman/listinfo/splat">Splat Mailing List</a>.
        </p>
        
        <h2><a id="caveats">Caveats</a></h2>
        <ul>
            <li>
                Splat current stores the full search result in memory. This may
                cause excessive memory consumption with extremely large result
                sets.
            </li>
            <li>
                Blocking LDAP calls are used. A complex query or
                overloaded/unreachable LDAP server may cause Splat to block for
                significant periods of time.
            </li>
            <li>
                TLS/SSL is supported, but StartTLS is not.
            </li>
        </ul>
        <p>
            These issues will be addressed in a future release. Patches are
            welcome.
        </p>
    </body>
</html> 
